browser/swagger-client.js: Throw errors for null types #508
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Avoid 'too much recursion' errors with properties like:
"species": {
"type": "string",
"enum": [
null,
"cat",
"dog"
]
}
The JSON Schema spec says for enums [1]:
> Elements in the array MAY be of any type, including null.
But they aren't supported by Swagger 2.0, because null isn't one of
Swagger 2's types [2,3]. This commit gives a more obvious hint about
that. It would be nice to have clarification in the spec so we could
link to tidier docs than the GitHub issue too [2].
It would be nice if I could point to line numbers (or the chain of
keys?) to find the broken entry in the parsed spec, but it doesn't
seem like that information is available in resolveAllOf and I'm not
clear enough on the larger picture here to know where that would plug
in.
[1]: http://json-schema.org/latest/json-schema-validation.html#anchor77
[2]: OAI/OpenAPI-Specification#229 (comment)
[3]: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#data-types
fehguy
added a commit
that referenced
this pull request
Jul 23, 2015
browser/swagger-client.js: Throw errors for null types
|
please note that I had to apply this: Since your commit was in the compiled library and would be overwritten on next build. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Avoid
too much recursionerrors with properties like:The JSON Schema spec says for enums:
But they aren't supported by Swagger 2.0, because null isn't one
of Swagger 2's types. This commit gives a more obvious hint about
that. It would be nice to have clarification in the spec so we
could link to tidier docs than the GitHub issue too.
It would be nice if I could point to line numbers (or the chain of
keys?) to find the broken entry in the parsed spec, but it doesn't
seem like that information is available in
resolveAllOfand I'm notclear enough on the larger picture here to know where that would plug
in.
Anyway, this PR should help avoid futher confusion on this issue in
the 2.0 series.